NAME
	GU_GetIMsg -- Get an IntuiMessage, process GadTools & Hotkey events.

   SYNOPSIS
	imsg = GU_GetIMsg(intuiport)
	D0,A0,SR(Z)       A0

	struct IntuiMessage *GU_GetIMsg(struct MsgPort *);

   FUNCTION
	Use GU_GetIMsg() in place of the usual exec.library/GetMsg() when
	reading IntuiMessages from your window's UserPort. If needed, the
	GadTools dispatcher will be invoked, and suitable processing will
	be done for gadget actions.
	If the message is an IDCMP_VANILLAKEY or an IDCMP_RAWKEY, this
	routine will search through all gadgets	for that key, and if it is
	found, the message will change to the type of message that gadget
	is supposed to send. If the key is not used as a hotkey, the
	message will not change. 
	If there are no messages (or if the only messages are meaningful
	only to GadTools/GadUtil), NULL will be returned.

   INPUTS
	intuiport - the Window->UserPort of a window that is using the
		GadUtil library.

   RESULT
	imsg - pointer to modified IntuiMessage, or NULL if there are
	       no applicable messages.

	SR (Z) - the zero flag will be set if there was no message. This
	       is probably only useful for assembly language programmers.

   NOTES
	Be sure to use GU_ReplyIMsg() and not exec.library/ReplyMsg() on
	messages obtained with GU_GetIMsg().
	If you intend to do more with the resulting message than read its
	fields, act on it, and reply it, you may find GU_FilterIMsg()
	more appropriate.

	Starting with V39 (of the OS), this function actually returns a
	pointer to an ExtIntuiMessage structure, but the prototype was
	not changed for source code compatibility with older software.

   SEE ALSO
	GU_ReplyIMsg(), GU_FilterIMsg()


[Main] [Previous] [Next]

Converted on 19 Jul 1996 with RexxDoesAmigaGuide2HTML by Michael Ranner.